home *** CD-ROM | disk | FTP | other *** search
/ Gigarom 1 / Gigarom Macintosh Archives (Quantum Leap)(CDRM1080320)(1993).iso / FILES / DEV / A-B / Alpha.5.05.cpt / Help / Alpha Tcl Extensions < prev    next >
Text File  |  1992-09-05  |  6KB  |  125 lines
  1. ==============================================================================
  2. = Alpha's Additional Tcl Commands
  3. ==============================================================================
  4.  
  5. Some as of yet have no descriptions. Sorry.
  6.  
  7. • aeSend <'signature'|name> <string> - Send a 'misc' 'dosc' Apple event 
  8.   to application named by either application signature (surrounded by 
  9.   single quotes), or Application name. Thus, you can have "Alpha 5.02" 
  10.   and "Alpha 5.02 Copy" sending Apple events to each other.
  11. • ascii (see bindings)
  12. • beep
  13. • bind  (see bindings)
  14. • blink <pos> - blink cursor at 'pos'
  15. • breakIntoLines <string> - return 'string' with 
  16.   carriage returns and spaces inserted to satisfy 
  17.   'leftFillColumn' and 'fillColumn' variables.
  18. • bringToFront <winName> - Bring named window to front.
  19. • colors <fore red> <fore green> <fore blue> <back red> <back green> <back blue>
  20. • createTMark <name> <pos> - create a temporary 'mark' 
  21.   at location 'pos'. 
  22. • deleteText <pos1> <pos2> - remove text between 'pos1' 
  23.   and 'pos2'
  24. • displayMode <mode> - Up to four characters of the 'mode' string are 
  25.   displayed in the status line at the bottom of a window.
  26. • echo <string> [<string>...] - echo the strings (used 
  27.   in shells).
  28. • edit <name> [readOnly] - open a file in a new 
  29.   window. Any second parameter causes the window to be
  30.   opened as read-only.
  31. • fileMenu <name> <dir> <rdonly> <list of menu items> - Defines a new user 
  32.   menu named 'name'. The menu is not yet inserted into the menubar. The menu 
  33.   commands may be nested for heirarchical menus, see 'AlphaBits.tcl' for 
  34.   examples. Unlike the 'menu' command, when items of this type of menu 
  35.   are selected the text is interpreted as a file-name, and Alpha attempts 
  36.   to open that file. The 'dir' argument is prepended to every file name 
  37.   before the file is opened. If 'rdonly' is non-zero, the file is opened 
  38.   read-only.
  39. • getGeometry - return a TCL list containing the left 
  40.   edge of the current window, the top, the width, and
  41.   height.
  42. • getMark - return the current mark.
  43. • getPos - return the current insertion point
  44. • getSelect - return the currently selected text, if 
  45.   any.
  46. • getText <pos1> <pos2> - return the text between 'pos1' 
  47.   and 'pos2'.
  48. • getVar <name> - return the value of the Alpha variable
  49.   'name'.
  50. • goto <pos> - goto the position 'pos'.
  51. • gotoTMark <name> - goto the temporary mark 'name'.
  52. • hiliteMenuItem <menuName> <itemNum> <on|off> - Either
  53.   enable or disable the 'itemNum'th menu item of user
  54.   menu 'menuName. Note that unless the menu is not only created, but also 
  55.   inserted, this command has no effect.
  56. • insertMenu <name> - insert the previously created user
  57.   menu 'name' into the menuBar.
  58. • insertText [-w <win name>] <text> [<text>]... - Insert 'text' at the current 
  59.   insertion point.
  60. • lineStart <pos> - return the position of the start of
  61.   the line 'pos' is on.
  62. • lookAt <pos> - return the 'pos'th character of the 
  63.   current file.
  64. • maxPos - returns the number of characters in the front
  65.   window.
  66. • menu <name> <list of menu items> - Defines a new user
  67.   menu named 'name'. The menu is not yet inserted into 
  68.   the menubar. The menu commands may be nested for 
  69.   heirarchical menus, see 'AlphaBits.tcl' for examples.
  70.   Alpha massages the function names to make them look better
  71.   in the menus.
  72. • message <string> - prints 'string' on the status line.
  73. • mkdir <name> - creates a directory (folder) named 
  74.   'name' in the current directory.
  75. • moveWin [win name] <left> <top> - moves current or specified window.
  76. • nextLineStart <pos> - return the position of the start 
  77.   of the next line after position 'pos'.
  78. • prompt <prompt> <default> [<name> <menu item>...]
  79.   - prompt dialog to the user with a prompt string and a
  80.   default value. The prompt dialog can optionally 
  81.   include a popup menu specified by 'name' and the 
  82.   succeeding strings. Selection of the popup menu items 
  83.   inserts the item text into the editable dialog item. 
  84.   'Prompt' returns the value of the editable item.
  85. • removeMenu <name> - remove menu 'name' from menubar.
  86. • removeTMark <name> - remove temporary mark.
  87. • replaceText <pos1> <pos2> <text> - replaces the text
  88.   between 'pos1' and 'pos2' with 'text'.
  89. • search <pattern> <pos> [limit] [noFail] - searches for 
  90.   'pattern' from position 'pos' using current values of
  91.   'forward', 'matchWords', 'ignoreCase', and 'regExpr'. 
  92.   If 'limit' is specified, the search fails if the a 
  93.   match is not found totally contained between 'pos' and
  94.   'limit'. If any fourth argument is specified, a search
  95.   failure still results TCL_OK. However, the result of
  96.   the call is then just an empty string. If the search
  97.   succeeds, a list of two positions will be returned. 
  98.   The first is the starting position of the match, the
  99.   second is one past the last character.
  100. • select <pos1> <pos2> - selects the text between 'pos1' 
  101.   and 'pos2'.
  102. • selEnd - returns the end of the hilited selection, or 
  103.   the current insertion point if no text is selected.
  104. • sendToBack <winName> - Sent named window to back.
  105. • setFSets - (see the File Sets section).
  106. • setVar <name> <value> - Sets the Alpha variable 'name' 
  107.   to 'value'.
  108. • sizeWin [win name] <width> <height> - sets size of current or specified window.
  109. • sortRange <fromPos> <toPos>
  110. • substituteVars <string> - Takes a single string and
  111.   substitutes for all variables inside it, regardless of
  112.   depth. Unfortunately, you currently need to make 'global var' 
  113.   declarations in the proc you call this for each 'var' that might need 
  114.   to be substituted in the string (see proc.tcl for examples).
  115. • switchTo <appName> - Switches to application 'appName'.
  116. • tclResult - displays a dialog showing the result of 
  117.   the last TCL evaluation.
  118. • traceFunc on <funcName> <winName> Trace 'funcName', send output to 
  119.                                     'winName'. 
  120.   traceFunc off                        Turn function tracing off.
  121.   traceFunc status                    Display current tracing status.
  122. • winNames - return a TCL list of all open windows.
  123. • wrapText
  124.  
  125.